Variable Properties
An object defining properties for the Variable class.
LinkedObjectName
The name of the object within the linked document that the variable corresponds to.
Type: string
TextML
A dictionary representing multilingual text values for the variable, allowing for language-specific text retrieval.
Type: Dictionary<string, string>
Key
A unique identifier for the workflow step.
Type: string
IsPublic
Specifies whether the variable is public, allowing access from other components or parts of the workflow.
Type: bool
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
LinkedDocumentObjectName
The name of the linked document object that the variable is associated with, if any.
Type: string
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
ValueType
The data type of the variable's value, such as integer, decimal, text, or date.
Type: VariableValueType
Accepted Values:
Name Value Text 0 Integer 1 Decimal 2 Date 3 Money 4 Boolean 5
IsLinked
Indicates whether the variable is linked to a document control, determining whether its value is sourced from a linked document object.
Type: bool
ValueSourceType
The source type of the variable's value, which determines where the value is retrieved from (e.g., document, position, profession).
Type: int
Name
Name for the workflow step.
Type: string
Value
The value of the variable. It can be a simple data type or a complex object, depending on the variable's configuration and source.
Type: object
Text
The text representation of the variable, used for displaying purposes, especially when the variable is linked to a document control.
Type: string
IsHtml
Indicates whether the variable's value or text should be treated as HTML content.
Type: bool
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>